Shareware Grab Bag

home *** CD-ROM | disk | FTP | other *** search

/ Shareware Grab Bag / Shareware Grab Bag.iso / 002 / ted36.arc / TED36.DOC < prev next >

Wrap

Text File | 1987-01-27 | 33.1 KB | 1,123 lines

T E D 3 6 version 2.1 a full featured text editor and screen designer for the IBM System/36 A SHAREWARE product from: ABRAXAS SYSTEMS P.O. Box 13 Grand Junction, CO 81502 (303) 434-5226 (303) 434-6456 (Bulletin Board) INDEX INTRODUCTION What is Shareware . . . . . . . . . . . . . . . . . . . 1 What is TED36 . . . . . . . . . . . . . . . . . . . . . 1 GETTING STARTED Introduction . . . . . . . . . . . . . . . . . . . . . . 3 File Naming . . . . . . . . . . . . . . . . . . . . . . 3 Status Line . . . . . . . . . . . . . . . . . . . . . . 3 Text Work Area . . . . . . . . . . . . . . . . . . . . . 4 Edit Codes . . . . . . . . . . . . . . . . . . . . . . . 4 Rolling . . . . . . . . . . . . . . . . . . . . . . . . 4 Finishing the Document . . . . . . . . . . . . . . . . . 4 EDIT CODES Introduction . . . . . . . . . . . . . . . . . . . . . . 5 Modifying Text Lines . . . . . . . . . . . . . . . . . . 5 Ditto'ing Lines . . . . . . . . . . . . . . . . . . . . 5 Deleting Lines . . . . . . . . . . . . . . . . . . . . . 5 Inserting Blank Lines . . . . . . . . . . . . . . . . . 6 Moving Lines . . . . . . . . . . . . . . . . . . . . . . 6 Predefined Text . . . . . . . . . . . . . . . . . . . . 7 Propagating Last Edit Code . . . . . . . . . . . . . . . 7 SCREEN DESIGN Introduction . . . . . . . . . . . . . . . . . . . . . . 8 Screen Attributes . . . . . . . . . . . . . . . . . . . 8 Special Characters . . . . . . . . . . . . . . . . . . . 9 Previewing Screens . . . . . . . . . . . . . . . . . . . 9 Permanently Translating Special Characters . . . . . . . 9 MISCELLANEOUS COMMAND KEYS Command keys . . . . . . . . . . . . . . . . . . . . . . 10 APPENDIX A: EDIT CODE SUMMARY APPENDIX B: COMMAND KEY SUMMARY APPENDIX C: ORDERING INFORMATION APPENDIX D: HISTORY OF CHANGES WHAT IS SHAREWARE? SHAREWARE assumes that you have a right to check out a piece of mailorder software before sending your check. This software is NOT free, or public domain, but is a copyrighted product with the customary restrictions against unauthorized copies. Try it out for a month and, if you like it, send me a check and you become a registered owner. If you don't feel a need for this product, just delete it. You are welcome (and, in fact, encouraged) to copy and circulate this demonstration package, by bulletin board, mail, and directly. Please be sure that this manual accompanies any copies you may make. There are several concrete advantages to becoming a registered owner: Additional features are available that are not implemented on the demonstration version. Upgrades will be available to registered owners via bulletin board or for the cost of diskettes and shipping. Add-on and enhancement packages are available. Complete, well-commented source code is supplied. Your support will save me from having to find a job. The demonstration version will stop working properly in 8 to 10 months. An order form is available in Appendix C of this manual. WHAT IS TED36? TED36 is a fast, easy to use, convenient text editor for the IBM System/36. It's for those of you who need to whip out the occasional memo, letter, or couple of pages of documentation. It may also be used to design screens, and is especially handy for Help screens. Even if your shop has lots of PC's around, loaded up with sophisticated word processors, the convenience of TED36 makes it a very handy tool. Here are some of TED36's features: Full screen editing of 23 lines at a time, each up to 77 characters long. Up to 192 lines (3 single spaced pages) per document. Online help for all functions. - 1 - All processing done in memory for maximum speed. Disk is only accessed at beginning and end of job. Edit codes control modification of individual lines: Moving and copying text Duplicating lines Line insertion and deletion Filling lines with predefined text Change to upper case, lower case, right align, left align, center, and erase Screen design aids, allowing specification and preview of screen attributes such as high intensity, reverse, blinking and underlined. Specification of keyboard characters to be translated to special screen characters, with preview and global translation options. Automatic backup of modified document files. Session constants may be saved with document files. Document may be printed, with various options. Documents may be saved in non-proprietary text format for use by other programs, including PC based ones. Procedure or Source library members may be edited. - 2 - GETTING STARTED This chapter is recommended reading for the TED/36 beginner. It will give you all the information you need to produce a document. Subsequent chapters will provide more detailed descriptions of the functions of this text editor. Online help is available at any time, just hit the HELP key. Assuming that you're logged onto the library that contains all of the text editor programs, just key: TED36 to begin. You'll be prompted for a file name. You can also use TED36 <filename> to begin, eliminating the additional prompt. FILE NAMING Whenever you create a new document or edit an existing one, you will be asked for a file name. The document file can be given any valid System/36 file name so long as the eighth character is not a "#" (pound sign). You may find it advantageous to set some file naming standards so that document files don't get scattered all over a CATALOG listing. I group mine with a "D." prefix. This makes them easy to find and simple to back up. THE STATUS LINE The top line of the text screen provides useful information about the status of your work. S= the relative line number, within the document, of the first text line on this screen. M= the number of lines of text currently in copy/move memory. H= the highest line number used by this document. R= the number of lines the screen will roll when you use command keys to roll up or down. I= the number of blank lines that will be inserted when using the "I" edit code. L= the row of the screen for the ruler line to be displayed when you use Command-6 to show line numbers and the ruler line. - 3 - TEXT WORK AREA There are 23 lines of 77 characters each that are used for freeform text entry. All of the customary System/36 workstation keys are usable. Each line is a separate field, so the field movement keys allow you to move from line to line. Text is displayed in such a way that Insert Mode can be used at any position in a line. EDIT CODES All of the special text processing features are controlled by edit codes. There is an edit code field to the left of each text line. Access to these fields is toggled on and off by Command-3. To specify editing you must toggle the edit mode on, enter edit codes on the lines affected, then press ENTER. The text will be redisplayed with all requested changes made. If any invalid edit codes were used the text will be unchanged and the questionable codes highlighted. ROLLING Move up and down within your document by using Command-1 and Command-2. Command-1 moves you forward by the number of lines specified in the roll factor. Command-2 moves you back the same number of lines. FINISHING THE DOCUMENT When you're through, use Command-7. A menu of End-of-Job options gives you a few final choices. One word of warning -- a "N" response to the "Save this document?" question means that your work will NOT be saved to disk and cannot be recovered. If you have specially defined any options (roll factor, insert factor, ruler line) or special screen characters, you may save these settings along with the document. Answer "Y" to "Save control information ?". - 4 - EDIT CODES Along the left side of the screen are 23 single-character fields, one for each line of text. TED36 starts up with these fields inaccessible; you need to use Command-3 to toggle edit code access on and off. Placing one or more edit codes in these fields then pressing ENTER will perform the specified editing and redisplay the modified text. Alphabetic edit codes can be entered in either upper or lower case. The ditto edit code can be entered as either a single quote (') or a double quote ("). The rest of this chapter is a detailed explanation of each edit code, grouped by general function. MODIFYING TEXT LINES This group of edit codes changes the marked line(s) only. Any number of them, in any combination, may be used with one screen. < - convert all alphabetic characters to lower case. > - convert all alphabetic characters to upper case. E - convert this line to all blanks. L - Left align, placing first non-blank character on the left margin R - Right align, placing last non-blank character on the right margin. X - Center text an equal distance from left and right margins. DITTO'ING LINES " or ' - Duplicate the line immediately above. Any text already on the marked line is replaced by the preceding line. This code is invalid on the top text line of a screen. DELETING LINES D - Remove this line from the document. Note the difference between this and the (E)rase edit code, which blanks a line but leaves the blank line in the document. Any number of (D)eletes may be used on one screen, but this code cannot be used in conjunction with any line movement edit codes. - 5 - INSERTING BLANK LINES I - The number of blank lines defined by the Insert Factor will be inserted in the document immediately before the indicated line. Only one (I)nsert may be used per screen, and this code cannot be used in conjunction with any line movement edit codes. MOVING LINES There are several types of text movement, each requiring a source and a target. Text movement may be direct or indirect. Direct moves occur when both source and target are on the same screen. Indirect moves require copying from source to Move Memory during one screen cycle, and later "pasting" the Move Memory text into a screen. Indirect movement allows you to move text from one screen to another. Move Memory is used for all moves. Indicated source lines will be moved into Move Memory, replacing anything already there. If this is a direct move the text will immediately be copied to the specified position on the screen, but will also remain in the Move Memory. This text may now be (P)asted into the document as many times as necessary, staying available until it's replaced by another move. The Status Line always shows how many lines of text are currently in Move Memory. These two edit codes define the source lines. As many lines as necessary may be indicated on one screen, but (C)'s and (M)'s may not be mixed. C - Copy. This text is to be moved but also remains in its present location. M - Move. This text is to be moved and is deleted from its present location. These three edit codes point to the target location. Only one target code may be used per screen. If code (A) or (B) is used, there must also be a (C) or (M) used on the same screen. A - Text being moved is inserted immediately above this line. B - Text being moved is inserted immediately below this line. P - Text from Move Memory is inserted immediately above this line. - 6 - PREDEFINED TEXT Using these codes will cause the indicated line(s) to be completely replaced by full lines of text that have been defined elsewhere. Any number of these edit codes may be used on one screen. 0 thru 9 - Replace the indicated line(s) with the corresponding line of text defined in the TED36 control file. Use the Control File Maintenance Program to define this text. S - Replace the indicated line(s) with a skeleton $SFGR S-spec. Y - Replace the indicated line(s) with a ruler line. PROPAGATING THE LAST EDIT CODE Command-9 will propagate the bottommost edit code through the remainder of the screen. As an example, if you were to enter text on the first line of the screen, place a (") edit code on the second line, and use Command-9, the top line would be duplicated on all the following 22 lines. - 7 - SCREEN DESIGN IBM's Screen Design Aid (SDA) is a useful utility, much easier to use than laboriously filling in screen layout charts and then copying the fields over to "S" and "D" specifications. TED36 is a whole lot easier. With word processing convenience you can design your screen, laying out text, controlling screen attributes such as high-intensity and blinking, and defining special screen characters that don't appear on your keyboard. This is especially handy for help screens (all help screens for TED36 were built using TED36). A document containing your screen layouts can be converted to "S" and "D" specs with a suitable conversion program (by strange coincidence, such a utility is available from Abraxas Systems; see Appendix C). SCREEN ATTRIBUTES How fields display on a System/36 workstation is controlled by invisible screen attribute codes. This S.A. code occupies one screen position. All screen positions following the S.A. code are displayed with this attribute until another S.A. code is found. TED36 defines 5 keyboard characters as artificial S.A. codes so that you can easily lay out a screen. Previewing screen attributes shows what these codes will do to the screen. These 5 special purpose keyboard characters have no effect on text documents and can be used freely. { - Begin high intensity display. } - Begin blinking display. | - Begin reversed display. _ - Begin underlined display. \ - (backslash) Begin normal display. As a brief example, the following line: This is{HIGH\and this is|REVERSED\text. would preview as: This is HIGH and this is REVERSED text. with "HIGH" in high-intensity and "REVERSED" showing in reverse. If you have the complete TED36 system, take a look at screen design documents ZD11HFM and ABRAXAS for some more examples. - 8 - SPECIAL CHARACTERS A System/36 workstation has approximately 190 separate displayable characters. The average keyboard has fewer than 100 characters. TED36 allows you to define keyboard characters that should be translated into special screen characters. You may then Preview your screen to temporarily translate these redefined keys, or you may permanently translate these characters throughout the document. While this chapter refers primarily to screen design, this feature also gives you access to additional printer characters. Conversion tables of keyboard to screen characters may be assigned to individual documents. These tables may also be stored in the Text Editor Control file to be applied to all documents. To use key redefinition, you must determine the hexadecimal value of the character you want to display. Use Command-0 to go to the Options Maintenance screen. The right half of this screen will show you the displayable characters and the corresponding hexadecimal representation. The first half of the hex code is shown along the top of the chart and ranges from "4" to "F" (screen characters X'00' through X'3F' have special functions and cannot be displayed with impunity). The second half of the hex code is shown along the left side of the chart, ranging from "0" to "F". The uppercase letter "D", for example, has a hexadecimal value of "C4". You may have up to 8 keys redefined at any on time. For each, you need to find an existing keyboard character that you aren't using, and the hex value of the corresponding screen character. The keyboard character goes in the KEYBOARD column, the hex value in the HEX VALUE column. Press ENTER to display the selected screen character in the SCREEN column. When you're finished, Command-0 to leave the Options screen and return to the Editor. Different workstations may interpret some hex values differently. You may want to view the chart of displayable characters on several machines to determine incompatablities. PREVIEWING SCREENS Command-4 will enable any screen attribute codes and translate any redefined keys so that you can see exactly what your customized screen will look like. Press ENTER to return to the Editor. No changes are made to your text when you use Previewing. PERMANENTLY TRANSLATING SPECIAL CHARACTERS Command-16 will convert any redefined keys to the corresponding special character, throughout your document. This is a permanent change. Command-16 has no effect on screen attribute codes. - 9 - SOME MISCELLANEOUS COMMAND KEYS Command-5 - Ask for line number to Go To. The text screen will be moved to this line of the document. Reply with a "0" if you want to ignore this Go To. Command-6 - Display screen with line numbers and ruler. Your text screen will be temporarily overlaid with line numbers of every other line and a ruler on the line defined by the Ruler Line constant. Changes you make to screens may not be stored in Main Document Memory right away. This allows you a limited "Undo" capability. You may make many changes to a screen, decide this isn't what you had in mind, and restore the screen to its original status with Command-14. If you are about to begin an ambitious modification you may want to first save the screen with Command-13 so that, in the event you want to start over, you have a starting point. Rolling up or down, or using the (C), (D), (I) or (P) edit codes will also save the screen to memory. Use of any of these features between Saving and Restoring the screen will probably mean that you don't get the same screen back that you thought you saved. Command-13 - Immediately save the screen to memory. Command-14 - Immediately restore the screen from memory. This may replace whatever is currently on the screen, so be careful. - 10 - Appendix A: EDIT CODE SUMMARY < - convert all alphabetic characters to lower case. > - convert all alphabetic characters to upper case. E - erase this line. L - align first character of text on left margin. R - align first character of text on right margin. X - center text. A - insert point is above this line. B - insert point is below this line. I - blank lines are to be inserted above this line. P - lines from memory are to be inserted above this line. D - delete this line of text. C - copy this line, without removing it from present location. M - move this line, deleting it from present location. " - replace this line with text on preceding line. 0 through 9 - replace this line with predefined text. S - replace line with $SFGR skeleton S-spec. Y - replace line with ruler line. Appendix B: COMMAND CODE QUICK REFERENCE Command-1 - Roll screen down (forward). Command-2 - Roll screen up (back). Command-3 - Toggle access to edit codes. Command-4 - Display screen with screen attributes and special characters enabled. Command-5 - Ask for a line number to GO TO. Command-6 - Display screen with line numbers and ruler. Command-7 - Ask for End-of-Job screen. Command-9 - Propagate bottommost edit code down rest of screen. Command-0 - Ask for Options screen. Command-13 (Command - Shift-1) - Copy contents of screen to Main Document Memory Command-14 (Command - Shift-2) - Restore screen from Main Document Memory Command-16 (Command - Shift-4) - Permanently translate special characters. Appendix C: HOW TO ORDER The full TED36 package is available on System/36 diskette for $29.95. This includes: The unrestricted TED36 program. The control file maintenance program. Complete RPG II source code for TED36, heavily commented. As an example of advanced RPG II string handling, this alone may be worth the price of the whole package. Complete user and technical documentation. A subscription to the new version notification service that lets you order improved versions of TED36 for $5.00. ALSO AVAILABLE FROM ABRAXAS SYSTEMS HELP36 - creates and compiles Help Screen source code from screens laid out with TED36 or any word processor. Does not require IBM's Screen Design Aid (SDA). PFMT36 - formats TED36 documents for printing, allowing redef- inition of margins, page length and line spacing, also specification of headers, footers, page numbering, line numbering, and various other parameters. PRTS36 - converts System/36 spool file entries to text files compatible with TED36 or PC processing. MENUD36 - prints images of all menus within a library, an invaluable first step for any system documentation. All software comes with a 30 day moneyback guarantee. ORDER FORM ABRAXAS SYSTEMS P.O. Box 13 Grand Junction, CO 81502 (303) 434-5226 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - QTY PRODUCT PRICE EXTENSION --- ------------ ------- --------- ___ TED36 Text Editor Demo Version $ 5.00 _______ ___ TED36 Text Editor Complete Registered Version $ 29.95 _______ ___ HELP36 Help Screen Creator $ 19.95 _______ ___ PFMT36 Text Formatter $ 12.95 _______ ___ PRTS36 Print Spool to Document Utility $ 12.95 _______ ___ MENUD36 Menu to Document Utility $ 12.95 _______ ___ All of the above (except the demo, of course) $ 59.95 _______ Subtotal $ _______ Colorado addressees please add 3% state tax $ _______ Total $ _______ This software is for a ___ System/36 ___ System/34 using ___ 8 inch ___ 5-1/4 inch diskettes Name: ____________________________________ Phone: _____________ Address: ________________________________________________ City, State, Zip: _______________________________________ Satisfaction guaranteed, or return the product within 30 days for a full refund. APPENDIX D: HISTORY OF CHANGES version 1.1 - begin using version numbers; store entire document in memory to eliminate sluggish screen processing; implement case conversion. version 1.2 - add cut & paste to allow movement of text from screen to screen; implement control constant maintenance and command-9 edit code propagation. version 1.3 - add end-of-job printout; implement keyboard character redefinition; implement preview of screen attributes and special characters. version 2.0 - rewrite the completely unintelligible sections of source code; store program constants in maintainable control file; allow use of 10 user-defined lines of predefined text. version 2.1 - enable easy use of keyboard insert function; clean and tidy source, adding extensive comments; rewrite the documentation. FUTURE ENHANCEMENTS (The following is true VaporWare, which may or may not ever see the light of day. I would very much appreciate any suggestions from users as to features they would like to see.) Implementation of some form of word wrap, making TED36 easier to use as a true word processor. Processing of a disk file in segments, removing the 192 line per document limitation without drastically slowing the program. Periodic saves to disk workfile with recovery provisions, preventing power loss from trashing entire documents. Conversion of some of the more tedious string handling to Assembler language subroutines for increased speed of processing. Implementation of an Include feature to grab text from another document. As of yet I can't think of any convenient way to do this in RPG II. Any suggestions?